home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / comm / mebbs / fuslist211.lha / fuslist_2.11 / FusList.doc < prev    next >
Text File  |  1994-09-01  |  11KB  |  298 lines
  1. ****************************************************************************
  2. *                                                                          *
  3. * FusList 2.5 by Robert Wahlström                       94-Sep-01          *
  4. *                                                                          *
  5. * Copyright (C) 1994 by Robert Wahlström    All rights reserved.           *
  6. *                                                                          *
  7. * FusList is a file list generating program for MEBBS BBS software.        *
  8. *                                                                          *
  9. * Written in SAS C 6.51 with CygnusED Pro and CHELP on Amiga 4000.         *
  10. *                                                                          *
  11. *  Robert Wahlström                                                        *
  12. *  Enehagsg 197                                                            *
  13. *  S-441 57  ALINGSÅS   SWEDEN                                             *
  14. *                                                                          *
  15. *  Usenet:  d0robert@dtek.chalmers.se                                      *
  16. *  Fidonet: Robert Wahlstrom@2:203/316.0                                   *
  17. *  Amiganet:Robert Wahlstrom@39:160/303.0                                  *
  18. *                                                                          *
  19. *                                                                          *
  20. *  UtilityBase +46-322-17877 (v32"+16.8k HST) 2:203/316.0 39:160/303.0     *
  21. *                                                                          *
  22. ****************************************************************************
  23. $VER: FusList.doc  2.5 (94-Sep-01)  by Robert Wahlström, Kjell Harnesk
  24.  
  25.                         FusList 2.5 by Robert Wahlström
  26.  
  27.  
  28. 1. INTRODUCTION
  29. ===============
  30.  
  31. WHAT IS FusList?
  32.  
  33. FusList is a file list generating program for MEBBS BBS software.
  34. It differs from most other lister programs in its configurability. It
  35. is powerful in both the way You select what areas to list and the way they
  36. are listed. All fields and characters between fields are Your choice. You
  37. can have as many diffrent setups as You like to generate diffrent lists
  38. for diffrent purposes.
  39.  
  40.  
  41.  
  42. 2. LICENSE
  43. ==========
  44.  
  45. This material is © Copyright 1994 by Robert Wahlström -- All rights reserved.
  46.  
  47. It may be distributed freely as long as the following restrictions are met:
  48.  
  49. The distributor may charge a fee to recover distribution costs. The fee for
  50. diskette distribution should not be more than the cost to obtain the same
  51. diskette from Fred Fish.
  52.  
  53. The distributor agrees to cease distributing the programs and data involved
  54. if requested to do so by the authors.
  55.  
  56. You may copy and distribute verbatim copies of the program's executable code
  57. and documentation as you receive it, in any medium, provided that you
  58. conspicuously and appropriately publish only the original, unmodified program,
  59. with all copyright notices and disclaimers of warranty intact and including
  60. all the accompanying documentation, example files and anything else that came
  61. with the original.                                         
  62.  
  63. The author will not be liable for any damage arising from the failure of this
  64. program to perform as described, or any destruction of other programs or data
  65. residing on a system attempting to run the program. While I know of no 
  66. damaging errors, the user of this program uses it at his or her own risk. 
  67.  
  68.  
  69.  
  70. REQUIREMENTS
  71. ============
  72.  
  73. AmigaDos 2.04 or above.
  74. mebbsutility.library 1.10
  75.  
  76.  
  77. INSTALLING
  78. ==========
  79.  
  80. Put the FusList drawer anywhere.
  81.  
  82.  
  83. RUNNING
  84. =======
  85.  
  86. FusList uses five files for formatting the output file. These are:
  87.  
  88. *.header - The header for the total list.
  89. *.footer - The footer for the total list
  90. *.beg    - The header for each area
  91. *.end    - The footer for each area
  92. *.main   - The design file for the actual filelist
  93.  
  94. Let's say You would like to generate two diffrent file lists. One for Your
  95. normal users and one for Your privileged users. You can then for example
  96. create two set of files, one called normal.header, normal.footer etc... and
  97. one set called priv.header, priv.footer etc...
  98. When You run FusList You just use "normal" or "priv" as infile without the
  99. .footer .header etc... extension. Examples will be given further down in
  100. this manual.
  101.  
  102.  
  103.  
  104. FusList takes the following arguments:
  105.  
  106.  
  107.  Usage: FusList <infile> <outfile> [options] [all] [level<XX] [<area #>] [<...>]
  108.  
  109.  [options]:
  110.  
  111.  [-a] - Alphbetical sort
  112.  [-A] - Reversed alphabetical sort
  113.  [-c] - Chronological sort
  114.  [-C] - Reversed chronological sort
  115.  [-e] - Check if file exists
  116.  [-n<n>] - <n> days to list
  117.  [-#] - Don't list area #
  118.  [+#] - Also list area #
  119.  
  120.  [all] - Lists all fileareas (1 to 256)
  121.  [area] - Lists [area]. (If used with [all] [area] is excluded)
  122.  
  123.  <infile>  - Infile path/name
  124.  <outfile> - Outfile path/name
  125.  
  126.  
  127. Examples:
  128.  
  129.  
  130.   FUSLIST t ram:list ALL    - list all areas to ram:list
  131.  
  132.   FUSLIST t ram:list ALL -n15  - list all areas to ram:list (files newer
  133.   than 16 days)
  134.  
  135.   FUSLIST t ram:list 9 12 14   - list only areas 9 12 14
  136.  
  137.   FUSLIST t ram:list 1 11-19   - list area 1  11 12 13 14 15 16 17 18 19
  138.  
  139.   FUSLIST t ram:list ALL 9 12 14 - list all areas except 9 12 14
  140.  
  141.   FUSLIST t ram:list LEVEL<6  - list all areas with access level less than 6
  142.  
  143.   FUSLIST t ram:list level<2 -36 +40 - List areas with access level less
  144.   than 2 BUT NOT area 36 and ALSO list area 40.
  145.  
  146. (In these examples, the t for infile means that a set of files named
  147. t.header, t.footer, t.beg, t.end and t.main will be used.)
  148.  
  149.  
  150.  
  151. Here are the keywords that can be used for the list formatting:
  152.  
  153. KeyWord       Length  Desc
  154. =======================================
  155.  
  156. Keywords for *.main (the actual filelist)
  157. ---------------------------------------
  158.    <filename> 12    Filename for the file. 8+3 format  ex: "File    .lha"
  159.   <filename2> 12    Filename for the file              ex: "File.lha    "
  160.        <path>  x    Complete path for the file
  161.       <level>  2    Minimun access level to download file
  162.          <dn>  3    Number of downloads
  163.        <date>  6    Date for the file. Format yymmdd
  164.       <datex>  -    Date for the file. See 1) for format/length
  165.        <time>  5    Time for the file. Format hh:mm  
  166.       <timex>  -    Time for the file. See 2) for format/length
  167.        <size>  7    Filesize in bytes
  168.      <sizekb>  4    Filesize in kb.
  169.        <des1> 50    File description line 1
  170.        <des2> 50    File description line 2
  171.    <uploader> 20    Name of uploader
  172.        <free>  3    Free download?
  173.     <unvalid>  3    Unvalid file?
  174.         <num>  3    Filenumber
  175.  
  176.     <if_des2> 50    Only print this line if second line description exists.
  177.  
  178. ---------------------------------------
  179. Keywords for *.beg, *.end (header and footer for each filearea)
  180. ---------------------------------------
  181.     <name>     32 Filarea name
  182.    <level>      2 Filarea accesslevel
  183.    <bytes>      9 Number of bytes in area
  184.   <kbytes>      6 Number of kb in area
  185.   <mbytes>      6 Number of Mb in area
  186.      <dls>      4 Number of downloads from area.
  187.    <files>      4 Number of files in area
  188.  <kbytedl>      6 Number of kb downloaded from area
  189.  <mbytedl>      6 Number of Mb downloaded from area
  190.  <topname>     12 Name of most downloaded file in area
  191. <toptimes>      4 Number of times the above file has been downloaded
  192. <topuploader>  20 Name of uploader of the above file
  193.  
  194. ---------------------------------------
  195. Keywords for *.header och *.footer (header and footer for the total list)
  196. ---------------------------------------
  197.   <bytes>      9 Total bytes in all areas
  198.  <kbytes>      6 Total kb in all areas
  199.  <mbytes>      6 Total Mb in all areas
  200.     <dls>      4 Total downloads
  201. <kbytedl>      6 Total kb downloaded from all listed areas
  202. <mbytedl>      6 Total Mb downloaded from all listed areas
  203.   <files>      4 Total number of files
  204.    <date>      6 Date in format yymmdd
  205.    <time>      5 Time in format hh:mm  
  206. <topname>     12 Most downloaded file from all areas
  207. <toptimes>     4 Number of times the above file has been downloaded.
  208. <topuploader> 20 Name of uploader of the above file
  209.  
  210. ---------------------------------------
  211. General (can be used anywhere)
  212. ---------------------------------------
  213.    <syscalls>      5    - Total cals to the BBS
  214.     <version>      4      Versionsnumber of FusList ex 2.2
  215.  
  216.  
  217.  
  218.  
  219.  
  220. 1)
  221.  
  222.            Format      Längd   EX:
  223. -------------------------------------
  224.   <time1>  hhmmss         6    212756
  225.   <time2>  hh:mm:ss       8    21:27:56
  226.   <time5>  hh:mm          5    21:27
  227.   <time6>  hr:mm:ss HH   11     9:27:56 PM
  228.   <time7>  hr:mm HH       8     9:27 PM   
  229.  
  230. The hh, mm, ss and dd terms are simply the 2-digit (BCD or ASCII)
  231. equivalents of the binary values in the time array.  The hr term is
  232. the 2-digit hour using the 12-hour form, and the HH term is either AM
  233. or PM.
  234.  
  235.  
  236. 2)
  237.            Format        Längd  Ex:
  238. --------------------------------------------
  239.   <date1>  yymmdd           6   921224
  240.   <date2>  mm/dd/yy         8   12/24/92
  241.   <date3>  mm-dd-yy         8   12-24-92
  242.   <date4>  MMM d, yyyy     12   DEC 24, 1992
  243.   <date5>  Mm...m d, yyyy  18   December 24, 1992
  244.   <date6>  dd MMM yy        9   24 DEC 92
  245.   <date7>  dd MMM yyyy     11   24 DEC 1992      
  246.   <date8>  dd/mm/yy         8   24/12/92 
  247.  
  248. In the above formats, MMM represents a 3-character month abbreviation
  249. in capitals, and Mm...m represents the full month name (e.g. January).
  250. The mm, dd and yy terms are 2-character month, day, and year,
  251. respectively, while d is the date with the leading zero suppressed.
  252. The yyyy term is the 4-character year obtained by adding 1980 to the
  253. first byte of the date array.
  254.  
  255.  
  256.  
  257. 7. ADDRESSES AND PHONENUMBERS
  258. =============================
  259.  
  260. If You have any questions, suggestions or bug-reports, please contact us.
  261. NetMail, snailmail, voice or logging on to our support bbs's.
  262. Here are addresses and phonenumbers:
  263.  
  264. Robert Wahlstrom
  265. Enehagsg 197
  266. S-441 57 ALINGSÅS
  267. SWEDEN
  268. phone: +46 (0)322-183 31
  269.  
  270. Support BBS:
  271.  
  272. UtilityBase
  273. +46 (0)322-178 77
  274. 24h 16800 baud HST, V32 bis
  275. Fido: 2:203/316.0  Amiganet: 39:160/105
  276. Usenet: d0robert@dtek.chalmers.se
  277.  
  278. 8. CREDITS
  279. ==========
  280. Thanks to the following for hints, suggestions and debugging:
  281.  
  282. Rikard & Fredrik Thulin - Original idea. Thanks for sourcecode to SLX.
  283. Kjell Harnesk           - Documentation, alfatesting, many ideas.
  284. Kjell Cederfeldt        - Alfatesting.
  285. Mikael Johansson        - Alfatesting, new ideas
  286. Stefan von Straten      - Mebbs support Sweden.
  287.  
  288. 9  Other programs by Robert Wahlström
  289. =====================================
  290.  
  291. FusAC   - Areafix for MEBBS
  292. FusTick - Program that handles file echo .tic files for MEBBS.
  293. FusEd   - A fullscreen editor for MEBBS
  294.  
  295. Chelp   - A help program for programmers - Lookup functions in autodocs
  296.           and strcuts/defines in includefiles
  297. Ast     - Astronomyprogram (beta only)
  298.